Promote gare from experimental
#1048
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sirosen
requested review from
aaschaer,
ada-globus,
derek-globus and
kurtmckee
as code owners
The `auth_requirements_error` module is moved to `globus_sdk.gare` and docs and importts are updated. Included in this change, `GlobusAuthRequirementsError` has been renamed to `GARE`, as the `Error` suffix to a name typically indicates that a class is an exception class. Aliasing has been put in place from `experimental` to the new code location. As a minor, related fix `_serializable.Serializable` now uses a `Self` type annotation, rather than a type var. This improves the doc rendering of the `from_dict` and `to_dict` methods, as they show the self-type rather than an unbound type variable T.
In order to use `typing.Self`, we must install `typing_extensions` on Python 3.10.
ada-globus
reviewed
Sep 17, 2024
ada-globus
reviewed
Sep 17, 2024
ada-globus
reviewed
Sep 17, 2024
ada-globus
reviewed
Sep 17, 2024
ada-globus
reviewed
Sep 17, 2024
And include testing of the rename aliases.
Co-authored-by: Ada <107940310+ada-globus@users.noreply.github.com>
ada-globus
approved these changes
Sep 17, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
auth_requirements_errormodule is moved toglobus_sdk.gareand docs and importts are updated.Included in this change,
GlobusAuthRequirementsErrorhas been renamed toGARE, as theErrorsuffix to a name typically indicates that a class is an exception class.Aliasing has been put in place from
experimentalto the new code location.As a minor, related fix
_serializable.Serializablenow uses aSelftype annotation, rather than a type var. This improves the doc rendering of thefrom_dictandto_dictmethods, as they show the self-type rather than an unbound type variable T.📚 Documentation preview 📚: https://globus-sdk-python--1048.org.readthedocs.build/en/1048/